<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkEventControllerKey: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="Gestures.html" title="Gestures and event handling">
<link rel="prev" href="GtkEventController.html" title="GtkEventController">
<link rel="next" href="GtkEventControllerScroll.html" title="GtkEventControllerScroll">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkEventControllerKey.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkEventControllerKey.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkEventControllerKey.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Gestures.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkEventController.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkEventControllerScroll.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkEventControllerKey"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkEventControllerKey.top_of_page"></a>GtkEventControllerKey</span></h2>
<p>GtkEventControllerKey — Event controller for key events</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkEventControllerKey.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GtkEventController.html" title="GtkEventController"><span class="returnvalue">GtkEventController</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkEventControllerKey.html#gtk-event-controller-key-new" title="gtk_event_controller_key_new ()">gtk_event_controller_key_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-focus-in" title="The “focus-in” signal">focus-in</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-focus-out" title="The “focus-out” signal">focus-out</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-im-update" title="The “im-update” signal">im-update</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-key-pressed" title="The “key-pressed” signal">key-pressed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-key-released" title="The “key-released” signal">key-released</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-modifiers" title="The “modifiers” signal">modifiers</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkEventControllerKey.html#GtkEventControllerKey-struct" title="GtkEventControllerKey">GtkEventControllerKey</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GtkEventController.html" title="GtkEventController">GtkEventController</a>
        <span class="lineart">╰──</span> GtkEventControllerKey
</pre>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.description"></a><h2>Description</h2>
<p><a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> is an event controller meant for situations
where you need access to key events.</p>
<p>This object was added in 3.24.</p>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-event-controller-key-new"></a><h3>gtk_event_controller_key_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkEventController.html" title="GtkEventController"><span class="returnvalue">GtkEventController</span></a> *
gtk_event_controller_key_new (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkEventControllerKey-struct"></a><h3>GtkEventControllerKey</h3>
<pre class="programlisting">typedef struct _GtkEventControllerKey GtkEventControllerKey;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkEventControllerKey-focus-in"></a><h3>The <code class="literal">“focus-in”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> *eventcontrollerkey,
               <span class="type">gpointer</span>               user_data)</pre>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkEventControllerKey-focus-out"></a><h3>The <code class="literal">“focus-out”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> *eventcontrollerkey,
               <span class="type">gpointer</span>               user_data)</pre>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkEventControllerKey-im-update"></a><h3>The <code class="literal">“im-update”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> *eventcontrollerkey,
               <span class="type">gpointer</span>               user_data)</pre>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkEventControllerKey-key-pressed"></a><h3>The <code class="literal">“key-pressed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> *controller,
               <span class="type">guint</span>                  keyval,
               <span class="type">guint</span>                  keycode,
               <span class="type">GdkModifierType</span>        state,
               <span class="type">gpointer</span>               user_data)</pre>
<p>This signal is emitted whenever a key is pressed.</p>
<div class="refsect3">
<a name="GtkEventControllerKey-key-pressed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>controller</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>the pressed key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keycode</p></td>
<td class="parameter_description"><p>the raw code of the pressed key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>the bitmask, representing the state of modifier keys and pointer buttons. See <span class="type">GdkModifierType</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GtkEventControllerKey-key-pressed.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the key press was handled, <code class="literal">FALSE</code> otherwise.</p>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkEventControllerKey-key-released"></a><h3>The <code class="literal">“key-released”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> *controller,
               <span class="type">guint</span>                  keyval,
               <span class="type">guint</span>                  keycode,
               <span class="type">GdkModifierType</span>        state,
               <span class="type">gpointer</span>               user_data)</pre>
<p>This signal is emitted whenever a key is released.</p>
<div class="refsect3">
<a name="GtkEventControllerKey-key-released.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>controller</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>the released key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keycode</p></td>
<td class="parameter_description"><p>the raw code of the released key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>the bitmask, representing the state of modifier keys and pointer buttons. See <span class="type">GdkModifierType</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkEventControllerKey-modifiers"></a><h3>The <code class="literal">“modifiers”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="GtkEventControllerKey.html" title="GtkEventControllerKey"><span class="type">GtkEventControllerKey</span></a> *eventcontrollerkey,
               <span class="type">GdkModifierType</span>        arg1,
               <span class="type">gpointer</span>               user_data)</pre>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="GtkEventControllerKey.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkEventController.html" title="GtkEventController"><span class="type">GtkEventController</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>